home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 001-025 / scopedisk11 / texted / manual next >
Text File  |  1995-03-18  |  21KB  |  449 lines
  1.         Welcome to TextED!!
  2.  
  3.   Congratulations!  You have just purchased the most
  4. powerfull text editor made for the Amiga!  TextED is
  5. a text editor that can be used by the casual user
  6. and by the advanced programmer.
  7.  
  8.   MKSoft TextED is based on the powerfull Unix text
  9. editor known as EMACS so most of the keyboard
  10. commands will be the same.
  11.  
  12.   This file contains a quick manual describing
  13. the features of MKSoft TextED.  Please expand this
  14. window to full size and read on....
  15.  
  16. -----------------------------------------------------------------------------
  17. -----------------------------------------------------------------------------
  18.     MKSoft TextED -- Copyright (c) 1986 by Michael Sinz -- MKSoft
  19. -----------------------------------------------------------------------------
  20. -----------------------------------------------------------------------------
  21.               Changes to TextED -- Amiga Version 2.8
  22.  
  23. 1.  The word-wrap function is debugged and installed in the menus.
  24.     This function only word-wraps on input.  TextED is not designed
  25.     as a word processor but rather a text processor, mainly for
  26.     program source code.  This feature was added for typing of large
  27.     comments.
  28.  
  29. 2.  Some of the routines have been optimized.  Many are now much smaller
  30.     or work faster.  (Sometimes both)
  31.  
  32. 3.  Now will open to FULL SCREEN on an INTERLACE workbench!
  33.  
  34. 4.  Better menu handling.  You can't flood it anymore.
  35.  
  36. 5.  Longer maximum line length.
  37.  
  38. 6.  Longer MACRO buffer.
  39.  
  40. 7.  Completely recompiled with AZTEC C for smaller/faster code
  41.  
  42. 8.  Does not bring up the CREDITS screen at the start of the program.
  43.     I have changed this so that TextED is faster to use from the CLI.
  44.     You now do not have to use the mouse to CONTINUE from that point.
  45.     It has been moved to a menu item.
  46.  
  47. 9.  All new FILE REQUESTER.  This one gives you a list of files in
  48.     alphabetical order with directories at the top.  Complete with
  49.     PROP gadget.  Simple to use.  Click on directory and it loads
  50.     the new directory.  Click on a file and it puts that file name
  51.     in the FILE gadget.  Click on OK and it uses the name in the file
  52.     gadget.  You can also enter the path and file names directly into
  53.     the gadgets.
  54.  
  55. 10. Fixed bug with FRIENDLY TOOL icons.  When starting TEXTED by selecting
  56.     a TextED Project icon or shift-collecting a text file and the TextED
  57.     program, the file and the program do not have to be in the same
  58.     directory or device.  This one was found using the AZTEC debugger
  59.     that comes with the compiler.  Highly recommended!
  60.  
  61. 11. All features work with FAST RAM installed.  No more problems with
  62.     CHIP memory graphics.
  63.  
  64. 12. Faster loading of files.  Sorry, but the clearing of a large buffer
  65.     still takes some time since it also deallocates the memory for that
  66.     buffer at the same time.  (Allocated on a LINE by LINE basis.)
  67.  
  68. 13. Does not bomb out it the workbench font is set differently.  It will
  69.     always reopen TOPAZ.8 as the TextED Font.   Only the window title
  70.     and top of menu bar will be in the workbench font.
  71.  
  72.               Changes to TextED -- Amiga Version 2.9
  73.  
  74. 14. Sets its priority to 1 so that background compiling does not slow down
  75.     the interactive aspects of TextED.  Since most of the time TextED is
  76.     waiting for user input, this setting does not slow down the compile
  77.     by any large amount.
  78.  
  79. 15. Increased the display speed by optimizing one of the routines.  I hope
  80.     it is fully debugged.  (Seems like it is, but there might be a few
  81.     small anoiances.  (Interlace mode, most likely)
  82.  
  83.               Changes to TextED -- Amiga Version 2.9a
  84.  
  85. 1.  Recompiled under Manx 3.4b for scatter loading...  Slightly larger
  86.     file, but it now loads into a highly fragmented memory space.  Also
  87.     the run-time image is smaller and runs faster...
  88.  
  89. 2.  Fixed the exit code so that it returns the task to initial priority
  90.     level.  This one was easy to fix, but I had a hard time trying to
  91.     find out why my task sometimes went to priority 1.  Finally found
  92.     out that TextED was leaving it there when it finished...
  93.  
  94. -----------------------------------------------------------------------------
  95. -----------------------------------------------------------------------------
  96.     MKSoft TextED -- Copyright (c) 1986 by Michael Sinz -- MKSoft
  97. -----------------------------------------------------------------------------
  98. -----------------------------------------------------------------------------
  99. 1.  Introduction
  100.  
  101.     TextED is an advanced text editor that was designed for the Amiga
  102. computer system.  It makes use of dynamic memory allocation so that it will
  103. only take as much memory as it needs for the files that it is editing. This
  104. means that you will have more memory available for other programs which
  105. might be running at the same time in your Amiga's multi-tasking OS. And,
  106. as your file gets larger, TextED will not tell you "BUFFER FULL" unless you
  107. have no more memory in the whole computer.  (0 bytes free at the top of the
  108. WorkBench display.)  So, if you have a 8 megabyte Amiga system, you would
  109. be able to edit a file that large!
  110.  
  111.     TextED knows if you are running from the WorkBench or the CLI and will
  112. act accordingly.  That means that when you use TextED from the WorkBench,
  113. it will save your files and attach an ICON to them.  But, for the advanced
  114. user who uses TextED from the CLI, it will not make an ICON for the files
  115. it saves.  This reduces the clutter on the disk for the advanced user while
  116. still giving the WorkBench user the ICONs he wishes.
  117.  
  118.     For the programmer, TextED features auto-indent and true tabs.  This
  119. reduces the time it takes to keyboard a program with indentation since
  120. TextED will automatically indent the next line the same as the line
  121. before.  Also, the tabs are stored as tabs and act as tabs which makes the
  122. files smaller and, for you assembly programmers, the changing of the
  123. program much faster.  While TextED is not a wordprocessor, it does have a
  124. word-wrap option.  This document was created with TextED.
  125.  
  126.     TextED has full menu support for all but the most basic functions such
  127. as cursor movement.  TextED also has a full help system that is available
  128. at the touch of the HELP key.  And, for you mouse lovers, the cursor can be
  129. positioned with the mouse.
  130.  
  131.     TextED, like the Unix EMACS editor, lets you edit multiple files at the
  132. same time.  You can even cut and paste between files.  There is no real
  133. limit on the number of files that can be edited at the same time other than
  134. memory limits, however, the number of "windows" or files visible at a time
  135. is limited by the size of this window.  Also, you can have two different
  136. views of the same file without having to load the file twice!  This makes
  137. debugging much easier since you can look back in the code without loosing
  138. your place. 
  139.  
  140. -----------------------------------------------------------------------------
  141.  
  142. 2.  The display...
  143.  
  144.     The TextED window is like any other window that you will use on the
  145. Amiga.  You can size it, drag it, or shuffle it.  It will respond to your
  146. every command.  It is in this window that TextED lives.  The bottom line of
  147. the display is used to give you messages and ask for special input such as
  148. a search string or file name.  The rest of the display is used by TextED to
  149. display its windows.  These windows are not like the other Amiga windows in
  150. that they are part of the TextED window.  These windows are "views" into
  151. the file or files you are editing.  The windows are separated by a status
  152. line which gives you the following information:
  153.  
  154.  « » buffername --» filename «-----------------------------------------------
  155.   ^    ^         ^
  156.   |    |         |
  157.   |    |         This is the name of the file being edited.
  158.   |    |
  159.   |    This is the name of the TextED buffer the file is in.
  160.   |
  161.   This is the status of the buffer.  If blank, the buffer is unchanged from
  162. what is in the file on disk.  If it has a  C  in it, the buffer has some
  163. changes and should be saved if you do not want to loose your work.
  164.  
  165.     When you split the screen, you get another view into the buffer you
  166. were working on.  You can then either work with that buffer or select a new
  167. buffer and edit a different file in there.  Try splitting the screen by
  168. using the menu or by pressing Shift-F2  (the 2 is for make 2 views).  You
  169. can the make a view get larger (F1) or smaller (F2) or split it again or
  170. make the current view the only one (Shift-F1).  Thus, with a full sized
  171. TextED window, you could have up to 11 different views on the screen at once!
  172.  
  173.     The CLOSE WINDOW gadget in the TextED window does not only quit TextED
  174. but also saves the current buffer if it has changed.  (It is the same as
  175. pressing F10 or ctrl-Z)  This is to protect you from any loss of text. (see
  176. the section on file i/o for more information on SAVE & EXIT)
  177.  
  178.     To move the cursor in the TextED window, you can use the mouse by
  179. pointing to the position you wish to move to or you can use the keyboard
  180. arrow keys.  Using the arrow keys without the Shift key moves the cursor
  181. one character in the direction of the arrow.  However, with the shift key
  182. held down while the arrow key is pressed, the cursor will move to the
  183. beginning or end of the line (Shift-Left and Shift-Right) or to the
  184. previous or next screen page (Shift-Up and Shift-Down).  Using CTRL and
  185. Shift makes the cursor move to the previous or next word (CTRL-Shift-Left
  186. and CTRL-Shift-Right) or to the beginning or end of the file (CTRL-Shift-Up
  187. and CTRL-Shift-Down)  This gives you complete control of the cursor.
  188.  
  189. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  190. NOTE: Due to a bug in the Amiga Console Device, these are the only functions
  191.       of the cursor keys.  When the bug is fixed, the keys will have the
  192.       following functions:   (Note: Version 1.2 Fixes this bug...)
  193.  
  194.  
  195. Key    | Plain      | Shift      | CTRL      | CTRL-Shift
  196. --------|------------|------------|-----------|------------
  197. Left    | Move one   | Beginning  | Previous  | Previous
  198. Arrow    | character  | of line      | word      | window
  199. --------|------------|------------|-----------|------------
  200. Right    | Move one   | End of      | Next      | Next
  201. Arrow    | character  | line      | word      | window
  202. --------|------------|------------|-----------|------------
  203. Up    | Move one   | Previous   | Beginning | Scroll
  204. Arrow    | line up    | page      | of file   | Up
  205. --------|------------|------------|-----------|------------
  206. Down    | Move one   | Next      | End of    | Scroll
  207. Arrow    | line down  | page      | file      | Down
  208. --------|------------|------------|-----------|------------
  209. +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
  210.  
  211. -----------------------------------------------------------------------------
  212.  
  213. 3.  Files and buffers...
  214.  
  215.     TextED uses a method of storing files in memory while they are being
  216. edited that facilitates the editing of unlimited number of files.  To keep
  217. track of all of this, the files are stored in buffers that are many times
  218. the same name as the file.  (Unless you asked differently)  While you are
  219. editing inside one buffer, the other buffer remains unchanged.  TextED even
  220. remembers where your cursor was when you left last.
  221.  
  222.     Each buffer also stores the name of the file that it is holding.  This
  223. information is displayed in the status line while you are working with that
  224. buffer.
  225.  
  226.     To edit a file, you just have to enter into TextED (run it or double
  227. click it from the WorkBench) and then ask to read a file into a buffer.
  228. There are two different versions of this command.  The first version reads
  229. the file into a new buffer.  That is, it creates a buffer different from
  230. the ones that you have already and then loads the file into it.  (This
  231. command is F8 or ^X^V)
  232.  
  233.     The second version reads the file into the current buffer.  This
  234. command destroys what was in that buffer and replaces it with the file. 
  235. Use this command to prevent having all of the files you are editing at one
  236. sitting from staying in memory.  (This is Shift-F8 or ^V^R)
  237.  
  238.     When you want to save the buffer, you again have two choices.  The
  239. first saves the buffer into the file which is shown in the status line. 
  240. The second lets you enter the name of the file into which the buffer is to
  241. be saved. (These are F9 and Shift-F9 respectively)
  242.  
  243.     When you wish to exit TextED, you can either Exit without saving the
  244. buffer or Exit after saving the buffer.  Only the current buffer is saved. 
  245. If there are any buffers that have been modified and not saved, TextED will
  246. ask you if you are sure you would like to quit.  If you answer NO, you will
  247. be in TextED as if you never left.  You can then save the buffers you want
  248. saved and then exit.  (The SAVE & EXIT command is F10 or the CLOSE WINDOW
  249. gadget.) 
  250.  
  251. -----------------------------------------------------------------------------
  252.  
  253. 4.  Cut and Paste -- EMACS style.
  254.  
  255.     TextED lets you cut and paste between buffers so that you can get data
  256. from one file into another.  However, TextED uses the EMACS method of Cut
  257. and Paste.  Here is a quick lesson on how to use these functions.
  258.  
  259.     In TextED, the section of the buffer you are going to Cut or Copy is
  260. called the REGION.  The region is defined as the section of the buffer
  261. between the MARK and the DOT (the DOT is another name for the CURSOR) The
  262. MARK is a position in the buffer that you set.  To set the MARK, move the
  263. cursor to the position and press F6 (or use the menu).  Then move the
  264. cursor to the other end of the section of text.  To cut the text, press
  265. Shift-F7 (or, again, use the menu).  To paste this text, press Shift-F6.
  266. You can move to a different buffer and paste the text again.  You can paste
  267. the text as many times as you want as long as you do not clear the paste
  268. buffer.  (The paste command is known as YANK in the EMACS world.)  The only
  269. other command that uses the paste buffer is ctrl-K (kill to end of line) or
  270. multiple deletes (Using the repeat command operator ctrl-U)
  271.  
  272.     The MARK is also useful for remembering a position while you go off and
  273. look at another area of the file.  You can then return to that position by
  274. using the SWAP DOT and MARK command.  (F7)  This command will place the
  275. cursor where the MARK was and place the MARK where the cursor was.  This
  276. lets you flop back and forth between two different areas of the file.  (A
  277. useful function for programmers.)
  278.  
  279.  
  280. 5.  Searching and Search & Replace
  281.  
  282.     TextED lets you search through the file for any type of string.  You
  283. can search foreward (F3) or reverse from the current cursor position.  If
  284. you would like to search for the third time the search string is found, use
  285. the repeat command operator.  (See the next section.)
  286.  
  287.     The search and replace function (Shift-F3) is somewhat like the search
  288. command.  However, it can only work forewards.  It will search for the
  289. search string and replace it with the replacement string.  It will only do
  290. this once, but if you would like to do the whole file, just enter a large
  291. number with the repeat command operator.  (See next section.)
  292.  
  293.     NOTE: Both search and search & replace ignore case.
  294.  
  295. -----------------------------------------------------------------------------
  296.  
  297. 6.  Repeating a command many times...
  298.  
  299.     Now this one is useful!  This is a pre-command sequence that will force
  300. the next command to be repeated as many times as asked for.  This command
  301. can be used to get to a specific line or to search & replace over the
  302. entire file.
  303.  
  304.     To use this command, type ctrl-U (or use the menu) and then the number
  305. of times you wish to repeat the command.  Use only numbers and do not try
  306. to BACKSPACE since this will BACKSPACE that many times.  If you make a
  307. mistake, press ctrl-G.  (Abort from the menu)  After you finished typing
  308. the number, type the command you wish to repeat (or use the menu).  DO NOT
  309. PRESS RETURN AFTER TYPING THE NUMBER.  That would only repeat the return
  310. key.  For example, if you wish to get to line 233 of your file, go to the
  311. top of the file and type the following:
  312.  
  313.                 <ctrl-U> <2> <3> <2> <down arrow>
  314.  
  315. The reason you entered only 232 is that you are on line one when you
  316. started so you only have 232 lines to go.  This is great for finding the
  317. lines with a compiler error.
  318.  
  319. To search & replace all (or most) of the buffer, you should type:
  320.  
  321.                 <ctrl-U> <9> <9> <9> <9> <9> <9> <Shift-F3>
  322.  
  323. and the search and replacement strings.  That should get most (if not all)
  324. of them.  (If you have more that 999,999 of the string, type a larger
  325. number. You can type up to 1,999,999,999 (without the comas) since the
  326. program uses a 32-bit integer.  However, anything over that amount could
  327. cause problems.) 
  328.  
  329. -----------------------------------------------------------------------------
  330.  
  331. 7.  The MACRO function...
  332.  
  333.     TextED has a simple macro function.  (Future versions of TextED will
  334. have an advanced MACRO language)  The MACRO function lets you record your
  335. keystrokes and then replay them when you want.  (It also works with the
  336. menus)  The MACRO may contain any command but the MACRO commands
  337. themselves. Thus you can make a MACRO that reformats your text.  (That one
  338. is neat!) To make a macro, you must tell TextED to start recording your
  339. keystrokes. This is done with Shift-F4.  When you have finished making you
  340. macro, you tell TextED by pressing Shift-F5.  Then, you can execute your
  341. macro by pressing F4.  (Again, you can use the MENUs for all of this.)  The
  342. macro may contain anything, including text or editing functions or even
  343. cut & paste commands.
  344.  
  345. -----------------------------------------------------------------------------
  346.  
  347. 8.  Command Summary
  348.  
  349.     Keys    Description                Amiga Keyboard
  350. ------------    -----------                --------------
  351. ctrl-@        Set MARK                <F6>
  352. ctrl-A        Go to beginning of line         <Shift-Left>
  353. ctrl-B        Left                    <Left>
  354. ctrl-C        Start a new CLI task
  355. ctrl-D        Delete next character            <DEL>
  356. ctrl-E        Go to end of line            <Shift-Right>
  357. ctrl-F        Right                    <Right>
  358. ctrl-G        Abort command (See note)
  359. ctrl-H        Backspace                <BACKSPACE>
  360. ctrl-I        Tab                    <TAB>
  361. ctrl-J        New line without auto-indent        <ENTER>
  362. ctrl-K        Delete to end of line
  363. ctrl-L        Repaint the whole screen
  364. ctrl-M        New line with auto-indent        <RETURN>
  365. ctrl-N        DOWN -- Next line            <Down>
  366. ctrl-O        Open line at cursor
  367. ctrl-P        UP -- Previous line            <Up>
  368. ctrl-Q        Quote next keystroke
  369. ctrl-R        Reverse search
  370. ctrl-S        Foreward search.            <F3>
  371. ctrl-T        Twiddle characters
  372. ctrl-U        set repeat command
  373. ctrl-V        Go to next page.            <Shift-Down>
  374. ctrl-W        Cut region.                <Shift-F7>
  375. ctrl-X        This is the leadin for other commands
  376. ctrl-Y        Paste (Yank) region back        <Shift-F6>
  377. ctrl-Z        Save and Exit                <F10>
  378.  
  379. <HELP>        Help on these commands            <HELP>
  380.  
  381.  
  382. -----------------------------------------------------------------------------
  383.  
  384. These commands are all started with typing ctrl-X and then the command listed
  385.             (Amiga Keyboard shortcuts do not need the ctrl-X)
  386.  
  387.  
  388.     Keys    Description                Amiga Keyboard
  389. ------------    -----------                --------------
  390. ctrl-B        List the buffers
  391. ctrl-C        Exit without save            <Shift-F10>
  392. ctrl-F        Rename the file in the buffer
  393. ctrl-L        Set region to lower case
  394. ctrl-N        Scroll up
  395. ctrl-O        Delete blanks
  396. ctrl-P        Scroll down
  397. ctrl-R        Load into current buffer        <Shift-F8>
  398. ctrl-S        Save buffer to file            <F9>
  399. ctrl-U        Set region to upper case
  400. ctrl-V        Load into new buffer            <F8>
  401. ctrl-W        Save to new file            <Shift-F9>
  402. ctrl-X        Swap DOT and MARK            <F7>
  403. ctrl-Z        Shrink window                <F2>
  404.   !        Execute a CLI command
  405.   =        Show cursor position and status.    <F5>
  406.   (        Start MACRO                <Shift-F4>
  407.   )        End MACRO                <Shift-F5>
  408.   1        Set current window to full size.    <Shift-F1>
  409.   2        Split current window            <Shift-F2>
  410.   B        Select a buffer to view
  411.   E        Execute the MACRO            <F4>
  412.   F        Set Wrap Column
  413.   K        Kill a buffer
  414.   N        Next window
  415.   P        Previous window
  416.   Z        Enlarge current window            <F1>
  417.  
  418. ctr-X <HELP>    Displays this list of commands
  419.  
  420. -----------------------------------------------------------------------------
  421.  
  422. These commands are all started with typing <ESC> and then the command listed
  423.             (Amiga Keyboard shortcuts do not need the <ESC>)
  424.  
  425.  
  426.     Keys    Description                Amiga Keyboard
  427. ------------    -----------                --------------
  428. ctrl-H        Delete previous word            <Shift-BACKSPACE>
  429.   !        Set cursor position as Top of Window
  430.   .        Set MARK                <F6>
  431.   >        Go to end of file            <Ctrl-Shift-Down>
  432.   <        Go to beginning of file.        <Ctrl-Shift-Up>
  433.   B        Move backward one word            <Ctrl-Shift-Left>
  434.   C        Capitalize word
  435.   D        Delete next word            <Shift-DEL>
  436.   F        Move foreward one word            <Ctrl-Shift-Right>
  437.   L        Set word to lower case
  438.   S        Search & Replace            <Shift-F3>
  439.   U        Set word to UPPER CASE
  440.   V        Move backward one page            <Shift-Up>
  441.   W        Copy region
  442.  
  443. -----------------------------------------------------------------------------
  444.  
  445. NOTE:    The ABORT command (ctrl-G) is used to abort any command that requires
  446.     keyboard input such as the SEARCH command or SELECT BUFFER command.
  447.  
  448. -----------------------------------------------------------------------------
  449.